FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.7.16  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package de.gematik.epa#1.1.5 (110 ms)

Package de.gematik.epa
Type CapabilityStatement
Id Id
FHIR Version R4
Source https://gematik.de/fhir/epa/https://simplifier.net/resolve?scope=de.gematik.epa@1.1.5&canonical=https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client
Url https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client
Version 1.1.5
Status active
Date 2025-05-28
Name EPABasicClient
Title EPA Basic Client
Experimental False
Realm de
Description Dieses Capability Statement beschreibt die Anforderungen an Clients, die den FHIR Data Service der ePA verwenden. Es legt fest, welche HTTP-Header obligatorisch sind und welche einheitlichen Fehlercodes im Fehlerfall zu erwarten sind.
Kind requirements

Resources that use this resource

CapabilityStatement
https://gematik.de/fhir/epa-mhd/CapabilityStatement/epa-mhd-document-consumer EPA MHD Service (Document Consumer - Client)
https://gematik.de/fhir/epa-medication/CapabilityStatement/epa-medication-service-client EPA Capability Statement für Clients des ePA Medication Service
epa-audit-event-client Capability Statement für Clients des ePA Audit Event Service
epa-patient-client Capability Statement für Clients des ePA Patient Service

Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement epa-basic-client

EPA Basic Client

  • Implementation Guide Version: 1.1.5
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json
  • Supported Patch Formats:
  • Published on: 2025-05-28
  • Published by: gematik GmbH

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

Summary of System-wide Interactions

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "epa-basic-client",
  "meta" : {
    "profile" : [
      "https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement epa-basic-client</b></p><a name=\"epa-basic-client\"> </a><a name=\"hcepa-basic-client\"> </a><a name=\"epa-basic-client-de-DE\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"https://simplifier.net/resolve?scope=de.gematik.ti@1.1.0&amp;canonical=https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement\">Capability Statement Profil für TI FHIR Data Service</a></p></div><h2 id=\"title\">EPA Basic Client</h2><ul><li>Implementation Guide Version: 1.1.5 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2025-05-28 </li><li>Published by: gematik GmbH </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div></div>"
  },
  "extension" : [
    {
      "extension" : [
        {
          "url" : "name",
          "valueString" : "X-Request-ID"
        },
        {
          "url" : "type",
          "valueString" : "string"
        },
        {
          "url" : "description",
          "valueString" : "UUID of the request message"
        },
        {
          "url" : "format",
          "valueString" : "uuid"
        },
        {
          "url" : "required",
          "valueBoolean" : false
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension" : [
        {
          "url" : "name",
          "valueString" : "x-insurantid"
        },
        {
          "url" : "type",
          "valueString" : "string"
        },
        {
          "url" : "description",
          "valueString" : "Health Record Identifier"
        },
        {
          "url" : "pattern",
          "valueString" : "^[A-Z]{1}\\d{9}$"
        },
        {
          "url" : "required",
          "valueBoolean" : true
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension" : [
        {
          "url" : "name",
          "valueString" : "x-useragent"
        },
        {
          "url" : "type",
          "valueString" : "string"
        },
        {
          "url" : "description",
          "valueString" : "user agent information"
        },
        {
          "url" : "pattern",
          "valueString" : "^[a-zA-Z0-9]{20}\\/[a-zA-Z0-9\\-\\.]{1,15}$"
        },
        {
          "url" : "required",
          "valueBoolean" : true
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Request does not match schema"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "invalAuth"
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Requestor has no valid entitlement"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "notEntitled"
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Requestor role is not in the list of allowed user groups"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "invalidOid"
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Device registration does not exist"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "unregisteredDevice"
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "404"
        },
        {
          "url" : "description",
          "valueString" : "Health record is in state UNKNOWN or INITIALIZED"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "noHealthRecord"
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "409"
        },
        {
          "url" : "description",
          "valueString" : "Health record is in state SUSPENDED"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "statusMismatch"
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "500"
        },
        {
          "url" : "description",
          "valueString" : "Any other error"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "internalError"
        }
      ],
      "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    }
  ],
  "url" : "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client",
  "version" : "1.1.5",
  "name" : "EPABasicClient",
  "title" : "EPA Basic Client",
  "status" : "active",
  "date" : "2025-05-28",
  "publisher" : "gematik GmbH",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.gematik.de"
        }
      ]
    }
  ],
  "description" : "Dieses Capability Statement beschreibt die Anforderungen an Clients, die den FHIR Data Service der ePA verwenden. Es legt fest, welche HTTP-Header obligatorisch sind und welche einheitlichen Fehlercodes im Fehlerfall zu erwarten sind.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "DE"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "client"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.